Agency Commission Enhancements in API Version 36 Onwards

1. Overview

With the release of API version 36, significant enhancements have been made to the handling of Agency Commissions within the AdBook platform. These changes aim to provide greater accuracy and flexibility by supporting decimal percentage values for Agency Commissions. This update addresses previous limitations where the AgencyCommission field in the Order object was restricted to integer values.

2. AgencyCommission Field Deprecation

The AgencyCommission field in the Order object has historically been an integer field. Starting from API version 36, this field is deprecated for setting decimal percentage values. While the field remains present in the Order object, its functionality has been limited to maintain backward compatibility:

• Retrieval: When using the GetOrder API call, the AgencyCommission field will always return a value of zero, regardless of any previously set decimal values.
• Modification: Attempting to create or update an Order with a non-zero value in the AgencyCommission field will result in a validation error. This ensures that only the supported method for setting decimal values is utilized.

3. OrderDynamicProperties

To accommodate the need for decimal precision in Agency Commissions, the OrderDynamicProperties object must now be used. This approach offers enhanced flexibility and precision for setting commission values. Below are the key aspects of using OrderDynamicProperties:

• Setting Decimal Values: The OrderDynamicProperties object allows users to input decimal values for Agency Commissions. The value is provided as a string that represents a decimal percentage (e.g., "5.8").
• Integration: When a decimal value is submitted via OrderDynamicProperties, the system accurately processes and stores the value within the Order. This ensures accurate and consistent data by not using the old AgencyCommission field.